home *** CD-ROM | disk | FTP | other *** search
/ Aminet 31 / Aminet 31 (1999)(Schatztruhe)[!][Jun 1999].iso / Aminet / util / time / KaiClock.lha / KaiClock / Docs / KaiClock.doc < prev    next >
Text File  |  1998-06-26  |  13KB  |  422 lines
  1. KaiClock 2.2 by Kai Software 1998
  2.  
  3.  
  4. Welcome to the doc file for KaiClock 2.2
  5. Please have patience (the doc file is a edit of the guide)
  6.  
  7.  
  8. Contents
  9.  
  10. Introduction
  11. Features
  12. Requirements
  13. Usage
  14. SHAREWARE Information
  15. Copyright & Disclaimer
  16. History
  17.  
  18. Please read the sections above carefully before using KaiClock.
  19. Please read Shareware and Copyright and Disclaimer information.
  20.  
  21. Thanks
  22. -Gonzo- of Kai  26/6/98
  23.  
  24.  
  25.  
  26.  
  27.  
  28. Introduction
  29.  
  30. Right, to start with, KaiClock is SHAREWARE
  31. I now assume that you have read the SHAREWARE information and, the
  32. condition of use.  If not do so now.
  33.  
  34. KaiClock is quite simply a digital clock for the Amiga (OS 2 and above)
  35. Like most clock programs on the Amiga, it can be placed on the screen to
  36. ascertain the time whenever you need it.  This is where most simalarities
  37. end.
  38.  
  39. Ok, its only a digital clock, but, hey, I made it primarily for me, 
  40. and I dont use analog clock programs (no offence, but I dont see the 
  41. attraction of programs like TolleUhr - just me I guess!)
  42.  
  43.  
  44.  
  45.  
  46. Features:
  47.  
  48. AppIcon Support
  49. AppMenu Support
  50. Upto 256 colours (AGA only)
  51. Uses a nice font (on both Interlace and non-Interlace)
  52. Can be placed anywhere on your workbench
  53. Has a date and weekday function
  54. Is configurable via tooltypes or a prefs program
  55. Sets off an alarm every hour (configurable)
  56. Alarm feature which displays a message of YOUR choice
  57. Can have a Depth gadget, or not, (its up to you)
  58. Low CPU usage
  59. Has some nice MWB icons
  60. Has some nice NewIcons
  61.  
  62. Anyway, thats most of the features.
  63.  
  64.  
  65.  
  66.  
  67. Requirements
  68.  
  69. You should have KaiClock.font in your FONTS: directory
  70. You should have an appicon selected, but its not required.
  71. To get the script working, you should have a script called KaiClock.scr
  72. in the same directory.  This is until you change the script name via the
  73. Tooltypes.
  74.  
  75.  
  76.  
  77. Usage
  78.  
  79.  
  80. KaiClock is mainly configured by use of Tooltypes.
  81. These can be set with the prefs program I've made, though, it MAY not 
  82. be available when you got KaiClock.
  83.  
  84. So I'll go over the tooltypes below:
  85. (Its best, that when you cancel a tooltype, rather than just deleting 
  86. it, just put brackets around it, this cancels it, but leaves the 
  87. tooltype there, in case you want to use it another time, without 
  88. trawling through these docs!)
  89.  
  90.  
  91. DRAG
  92. This tooltype either puts a dragbar on the window, or takes it off, 
  93. when on, there is also a depth gadget.  The dragbar is the easiest way
  94. to move the window around.
  95.  
  96. DATE
  97. Either turns the date on or off, when its on, the window size will 
  98. change, and the date will be placed under the time.  Kaiclock 
  99. remembers where the window was, so, if the window appears, and it 
  100. would go over the edge of the screen, it moves itself to the top left 
  101. of the screen.  (this is a feature not a bug ok?)
  102.  
  103. WDAY
  104. This places the weekday on the window (or takes it off), for this 
  105. tooltype to work, the DATE tooltype must also be used, if DATE 
  106. tooltype is not used, this tooltype will have no effect.
  107.  
  108. PLACE
  109. This, I have found is the easiest way to place a window.  I used to 
  110. use XPOS and YPOS, whereby you could just dump the numbers in, but, if
  111. an unsuitable value (It went off screen) my Amiga GURU'd which really 
  112. did get on my nerves after some time, so, instead, I decided to use 
  113. the PLACE tooltype, it only has 4 values, 1 2 3 or 4
  114. (Just the number)
  115. 1 = Top left of screen
  116. 2 = Top right of screen
  117. 3 = Bottom left of screen
  118. 4 = Bottom right of screen
  119. If you want anywhere else, just use the drag bar
  120.  
  121. TEXTCOL
  122. This is, as you might have guessed the text colour, you can have 
  123. whatever colour from you rworkbench palette you want, you can pick it 
  124. by entering a number between 0 and the number of colours available, on
  125. an AGA, this can be upto 256.
  126. The default value is 1 (Black)
  127.  
  128. BACKCOL
  129. This, (like TEXTCOL) you might be able to guess for yourself, no?
  130. Ok, this is the background colour, which has the same features of 
  131. TEXTCOL, so read that.  The default is 0 (workbench background colour,
  132. usuall grey)
  133.  
  134. ALARM
  135. This can be ON or OFF, it turns the alarm on or off funnily enough.
  136.  
  137. ALARMSET
  138. This can be any time in the day.
  139. It goes in the format of:
  140.  
  141. HH:MM:SS
  142.  
  143. Where HH is the hour, MM is the minutes and SS the seconds.
  144. One thing I should mention is, that each of the numbers, MUST be in 
  145. double figures, so if you want the alarm to go off a 5 past 8 it would
  146. be
  147. 08:05:00
  148. NOT: 8:5:0
  149. (Failure to set it properly, results in a failure for it to work)
  150.  
  151. MESSAGE
  152. This can be ON or OFF, it turns the message on or off.
  153.  
  154. MESSAGESET
  155. This is the message for MESSAGE
  156. It can be as long as you set it.  To start a new line, use the |
  157. (Thats the one next to DEL (with shift)
  158.  
  159. SCRIPT
  160. This will turn on the script handling.
  161. The Alarm feature must be active, so that when the alarm goes off,
  162. the script can be executed.
  163.  
  164. SCRIPTNAME
  165. Gives an alternative name for a script to be executed.
  166. By default this is Kaiclock.scr and should be in the drawer
  167. where KaiClock is.
  168. The Script should be something like the startup-sequence
  169. which can be executed... See the example below.
  170.  
  171. Script Example
  172.  
  173. Run >Nil: C:NewShell
  174. Run >Nil: C:Fastview Work:Pics/Pic
  175. C:Flush
  176.  
  177. APPICON
  178. This is the appicon to use.
  179. This appicon will be used when you put KaiClock to 'SLEEP'
  180. Pick the info file to use, with the path, but DO NOT put the .info 
  181. on the end of it.
  182. I put the APPICON drawer in the same dir and use
  183. APPICON=AppIcon/KaiApp
  184.  
  185. Anyway, the choice is yours
  186.  
  187. Below is an examples of these settings.
  188.  
  189. (DRAG)
  190. (DATE)
  191. (WDAY)
  192. PLACE=2
  193. TEXTCOL=1
  194. BACKCOL=0
  195. ALARM=ON
  196. ALARMSET=08:05:31
  197. MESSAGE=ON
  198. MESSAGE=KaiClock V1.7c|by Kai Software
  199. APPICON=AppIcon/KaiApp
  200.  
  201.  
  202. What? Everything is set by tooltypes?
  203. No.  There is also the pulldown menu, and the appmenu.
  204.  
  205. The pulldown menu is used to perform SOME of the above features.
  206. The pulldown menu is laid out as:
  207.  
  208. Kai
  209. Window
  210.  
  211. Kai
  212. This has three selections available.
  213. About
  214. Sleep
  215. Quit
  216.  
  217. About, gives some basic info
  218. Sleep, places an appicon on workbench, and closes the window, its 
  219. basically the same as quitting, but with the option of ressurecting it
  220. later.  (Alarms do NOT work while it is 'sleeping')
  221. Quit, quits.
  222.  
  223. Window, has four functions
  224. Drag, same as the DRAG tooltype
  225. Date, same as the DATE tooltype
  226. Weekday, same as the WDAY tooltype
  227. Place, same as the PLACE tooltype
  228.  
  229. Finally, however, there is the Appmenu.
  230.  
  231. On the normal Workbench menu, under TOOLS, you will get KaiClock Sleep
  232. after starting the program, this works the same as the Sleep pulldown 
  233. function.  Plus, when Kaiclock is 'sleeping' this will change to Wake 
  234. KaiClock, so if there is a problem with the Appicon, you can still 
  235. wake it up.
  236.  
  237. Thats it on the configurable stuff.
  238.  
  239.  
  240. Shareware Information
  241.  
  242. Response on my previous programs has been pretty disappointing, when I
  243. consider the time taken on them.  So I started to use Keyfiles, response
  244. has picked up a little, however, I was still not satisified, as the keyfile
  245. was easy to tamper with the keyfile to get it working.
  246. So from now, I have intoduced a better keyfile system, which (I hope) will
  247. not be breakable easily.
  248.  
  249. And thus, as I have spent a vast amount of time perfecting KaiClock to my
  250. own strict requirements (See History)...
  251.  
  252. KaiClock is now SHAREWARE!
  253.  
  254. KaiClock will only cost you a measly £5.00
  255.  
  256. So, to recieve your keyfile, please pop £5 into an envelope, or cheques
  257. and postal orders (Made out to Kevin Mckenna)
  258.  
  259. Then send it, with a note of your current setup, where you found KaiClock
  260. What you thought of it, any bug reports or sugestions.
  261. Then add the code:  KaiV2.2Clock
  262. This will ensure that you will recieve the correct keyfile.
  263.  
  264. Also, you will recieve the latest version, and some other programs which
  265. I have made that are still FREEWARE.
  266.  
  267. Send your registration to:
  268.  
  269. Kai c/o
  270. Kevin Mckenna
  271. 11 Louis Braille Close
  272. Netherton
  273. Liverpool
  274. L30 5SN   <----   (thats five S N)
  275. ENGLAND
  276. Also... 
  277. I need feedback, I need to know if anyone is using my programs, because
  278. if not I'll not waste my time on them, but rather carry on with some other
  279. projects.   Even if you DONT want to register, please drop me a line and
  280. give me some feedback!
  281.  
  282.  
  283.  
  284. Copyright and Disclaimer Information
  285.  
  286.  
  287. Standard disclaimer:
  288.  
  289. THERE IS NO WARRANTY FOR THIS PROGRAM TO THE EXTENT PERMITTED BY APPLICABLE
  290. LAW.  EXCEPT WHERE OTHERWISE STATED IN WRITING THE COPYRIGHT HO